CreateOwnerIterator

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODArbitrator

CreateOwnerIterator
The CreateOwnerIterator method creates a focus-owner iterator to give callers access to the frames that own a nonexclusive focus.
ODFocusOwnerIterator CreateOwnerIterator (
                                    in ODTypeToken focus);
focus
A tokenized string representing the focus type whose owners you want to access, expressed as a 32-bit value.
return value
A reference to a new focus-owner iterator object, or kODNULL if the specified focus is exclusive.

DISCUSSION
The focus parameter must be the tokenized form of one of the focus constants (kODClipboardFocus, kODKeyFocus, kODMenuFocus, kODModalFocus, kODMouseFocus, kODScrollingFocus, or kODSelectionFocus) or the tokenized form of a part-specific focus type. You can call the session object's Tokenize method to obtain a token corresponding to one of these constants.
To get access to the owner of an exclusive focus, use the arbitrator's AcquireFocusOwner method.
While you are using a focus-owner iterator, you should not modify the list of focus owners. You must postpone adding items to or removing items from the list of focus owners until after you have deleted the iterator.

EXCEPTIONS

kODErrFocusNotRegistered
The specified focus is not registered.
kODErrOutOfMemory
There is not enough memory to allocate the focus-owner iterator object.

SEE ALSO
The ODFocusType type (page 889).
The ODTypeToken type (page 877).
The ODArbitrator::AcquireFocusOwner method (page 45).
The ODSession::Tokenize method (page 622).
The ODFocusOwnerIterator class (page 278).
"Focus Modules for Nonexlusive Foci" on page 450 in OpenDoc Programmer's Guide.
Table 11-1 on page 466 in OpenDoc Programmer's Guide.